/**
 * Copyright (c) 2003, 2004, Chess iT
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of Chess iT, nor the names of its contributors may be used 
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 */
package nl.chess.it.util.config.examples.newvalidation;

import nl.chess.it.util.config.Config;
import nl.chess.it.util.config.InvalidPropertyException;


/**
 * This class shows how to provide project-specific validation on properties. It has a single method, that returns an <i>int</i>
 * that is always even. This means that the caller can always be sure that the <i>int</i> returned is an even number.
 * 
 * <p>
 * It is possible to extend this behavior, to return real project specific objects. This is a matter of personal taste. Next to
 * that, if a real project object is returned, it often requires a database to exist and functioning. Obviously this doesn't work
 * when the configuration details are not known yet.
 * </p>
 *
 * @author Guus Bosman (Chess iT)
 * @version $Revision: 1.1.1.1 $
 */
public class CustomValidationConfig extends Config {
    /**
     * Name of the file we are looking for to read the configuration.
     */
    public static final String RESOURCE_NAME = "customvalidation.properties";

    public CustomValidationConfig(String resourceName) {
        super(resourceName);
    }

    /**
     * Return the amount of legs that has been defined in the properties.
     *
     * @return Even number of legs.
     */
    public int getAmountOfLegs() {
        int value = getInt("amount.of.legs");

        if ((value % 2) != 0) {
            throw new InvalidPropertyException("amount.of.legs", "" + value, "even number");
        }

        return value;
    }
}
